feat: add OnStart hook for synchronous startup jobs #2079

HeerakKashyap · 2025-07-19T17:20:13Z

Description:

Implements an OnStart hook for the GoFr framework, allowing users to register synchronous startup jobs that execute before the server starts.
The hook receives a fully initialized *gofr.Context with all DI-managed services, as requested by maintainers.
Removes any previous custom context logic and follows the GoFr way for dependency injection.
Updates documentation and provides usage examples.
Includes proof of working feature (see attached screenshots).

Testing:

Verified that OnStart hooks can access DI-managed services (e.g., SQL, Redis).
All relevant tests pass with MySQL and Redis running in Docker.

Fixes #1833

Let me know if you want to add or change anything, or if you need help attaching screenshots or filling out the checklist!

…ode quality

go.work.sum

pkg/gofr/run.go

Umang01-hash

There are no tests added for the newly added code.
No documentation updates for the new feature.
We have following code quality/linter issues in your PR:

Please resolve them along with other review comments.
Thankyou

pkg/gofr/run.go

examples/http-server/main.go

…t DI access

HeerakKashyap · 2025-07-21T13:35:36Z

There are no tests added for the newly added code.

No documentation updates for the new feature.

We have following code quality/linter issues in your PR:

Please resolve them along with other review comments. Thankyou

should i update iin readme.md , it would be okay to do so right ? @Umang01-hash

Umang01-hash · 2025-07-21T13:43:42Z

There are no tests added for the newly added code.

No documentation updates for the new feature.

We have following code quality/linter issues in your PR:

Please resolve them along with other review comments. Thankyou

should i update iin readme.md , it would be okay to do so right ? @Umang01-hash

@HeerakKashyap I think we can update the existing docs or maybe create a new one for the same. Both can work depending upon the content we are sharing.

- Move OnStart logic to a dedicated, testable method. - Fix all linter issues (deep-exit and cyclomatic complexity). - Add unit tests for success and error cases. - Add comprehensive documentation with a realistic example. - Update the example app to demonstrate a real-world use case.

HeerakKashyap · 2025-07-21T14:41:06Z

Test case are working fine @Umang01-hash @ccoVeille

pkg/gofr/run.go

…own on context cancel)

…hyap/gofr into fix/onstart-di-context

HeerakKashyap · 2025-07-22T18:29:48Z

kidnly have a look @ccoVeille @Umang01-hash

pkg/gofr/run.go

ccoVeille · 2025-07-22T19:12:51Z

The code is in, but I would prefer if the context was not forged twice.

Can't we create the gofr.Context before calling startup hooks, then pass it through all the layers as argument up to the place where the gofr.Context is created now?

Or would this implies breaking changes,? Or simply too much changes?

Please note, it doesn't necessary have to be addressed in this PR.

HeerakKashyap · 2025-07-23T04:57:22Z

The code is in, but I would prefer if the context was not forged twice.

Can't we create the gofr.Context before calling startup hooks, then pass it through all the layers as argument up to the place where the gofr.Context is created now?

Or would this implies breaking changes,? Or simply too much changes?

Please note, it doesn't necessary have to be addressed in this PR.

Thank you for the suggestion Sir! @ccoVeille

I agree that creating the gofr.Context only once and passing it through would be cleaner and more efficient.
However, implementing this would require significant refactoring and could potentially introduce breaking changes, especially if other parts of the framework expect to construct their own context.

For this PR, I’ll keep the current approach to avoid introducing breaking changes, but I think this is a great idea for future improvement and can be considered in a dedicated refactor.

HeerakKashyap · 2025-07-23T05:08:39Z

@Umang01-hash sir, kindly run the workflows and let me know is there now any linter errors etc.

pkg/gofr/gofr.go

Umang01-hash · 2025-07-23T07:27:38Z

Hey @HeerakKashyap only a few things:

Changes in go.work.sum file needs to be reverted.
We dont need a newContextForHooks methods, we can use exitisting methods to create new context.
A lot of linter errors are there in the code we need to resolve them.

Please do the above changes and we should be ready to go with your PR.

- Fix dynamic error definition - Fix unused parameters with underscore - Use t.Context() instead of context.Background() - Use assert.NoError instead of assert.Nil

- Fix cuddled return statement in newContextForHooks - Fix cuddled assignment in OnStart test - Remove os.Exit call to resolve deep-exit error

…ction

HeerakKashyap · 2025-07-30T05:05:12Z

@coolwednesday The distinction between context.Canceled and other errors is :

context.Canceled (graceful shutdown):

User initiated shutdown (Ctrl+C, SIGTERM)
Application should exit cleanly without error messages
No need to log as "Startup failed" since it's intentional

Other errors (startup failure):
Actual problems during startup (DB connection failed, config errors, etc.)
Should log as "Startup failed" for debugging
Application should exit with error status

Example scenarios:

context.Canceled: User hits Ctrl+C during startup → graceful exit
Other error: Redis connection fails → log error and exit with failure status

I believe this allows users to distinguish between intentional shutdowns and actual startup problems.

coolwednesday · 2025-07-31T07:30:21Z

@HeerakKashyap , Please address all the review comments, so that we can close this ASAP.

HeerakKashyap · 2025-07-31T10:09:33Z

@HeerakKashyap , Please address all the review comments, so that we can close this ASAP.

I've given replies above for the same , so should i do all the changes given by the maintainers ?

coolwednesday · 2025-07-31T11:20:00Z

@coolwednesday The distinction between context.Canceled and other errors is :

context.Canceled (graceful shutdown):

User initiated shutdown (Ctrl+C, SIGTERM)

Application should exit cleanly without error messages

No need to log as "Startup failed" since it's intentional
Other errors (startup failure):

Actual problems during startup (DB connection failed, config errors, etc.)

Should log as "Startup failed" for debugging

Application should exit with error status

Example scenarios:

context.Canceled: User hits Ctrl+C during startup → graceful exit

Other error: Redis connection fails → log error and exit with failure status

I believe this allows users to distinguish between intentional shutdowns and actual startup problems.

If we are thinking about graceful exit. It should happen in all cases. That is all the DB/Stream Connections started should be closed with graceful exit. Keep Context.Canceled only.

coolwednesday · 2025-07-31T11:20:13Z

@HeerakKashyap , Please address all the review comments, so that we can close this ASAP.

I've given replies above for the same , so should i do all the changes given by the maintainers ?

Yes Please address them.

…e API usage

…hyap/gofr into fix/onstart-di-context

coolwednesday

Added some documentation fix. Rest LGTM.

Thanks !

pkg/gofr/gofr_test.go

Co-authored-by: ccoVeille <[email protected]>

* Fix/pubsub migration get last version (#2119) * add chaining of next migrator in getLastVersion method of pubsub.go * fix linter * feat: add OnStart hook for synchronous startup jobs (#2079) * feat: improve OnStart hook with DI context, update docs, and ensure code quality * refactor: improve OnStart hook context, move logic to method, and test DI access * feat(onstart): implement all reviewer feedback - Move OnStart logic to a dedicated, testable method. - Fix all linter issues (deep-exit and cyclomatic complexity). - Add unit tests for success and error cases. - Add comprehensive documentation with a realistic example. - Update the example app to demonstrate a real-world use case. * fix: improve startup error handling for OnStart hooks (graceful shutdown on context cancel) * fix: address linter errors in OnStart tests - Fix dynamic error definition - Fix unused parameters with underscore - Use t.Context() instead of context.Background() - Use assert.NoError instead of assert.Nil * fix: remove os.Exit call to resolve deep-exit linter error * fix: resolve remaining linter errors - Fix cuddled return statement in newContextForHooks - Fix cuddled assignment in OnStart test - Remove os.Exit call to resolve deep-exit error * refactor: remove newContextForHooks and reuse existing newContext function * fix: resolve linting errors and refactor Run() method for better maintainability - Fix err113: Replace dynamic error creation with static error in TestApp_OnStart - Fix gocyclo: Refactor Run() method by extracting helper methods to reduce cyclomatic complexity - Fix ws1: Correct whitespace issues in gofr_test.go and run.go - Add helper methods: handleStartupHooks, startShutdownHandler, startTelemetryIfEnabled, startAllServers - Improve code organization and readability while maintaining functionality * fix: resolve remaining linting issues in TestApp_OnStart - Fix err113: Move error variable to package level to avoid dynamic error creation - Fix error-naming: Rename hookFailedErr to errHookFailed following Go naming conventions - Fix whitespace: Remove unnecessary blank line before app assignment - All linting issues in modified files are now resolved * fix: resolve godot and wsl linter errors in run.go and gofr_test.go * Update go.work.sum * fix: restore comments as requested by reviewer * Update run.go * Update run.go * fix: address reviewer comments - add godoc comment to OnStart method and move startup-hooks.md to proper directory structure * fix: restore metrics server comments and ensure OnStart hook runs before route registration * fix: implement proper context usage in runOnStartHooks and fix example API usage * Update go.work.sum * fix: correct spelling of 'canceled' in comment * minor documentation fix * revert go.sum changes * Update pkg/gofr/gofr_test.go Co-authored-by: ccoVeille <[email protected]> * revert go.work.sum changes --------- Co-authored-by: HeerakKashyap <[email protected]> Co-authored-by: Umang Mundhra <[email protected]> Co-authored-by: coolwednesday <[email protected]> Co-authored-by: Divya Darshana <[email protected]> Co-authored-by: ccoVeille <[email protected]> * build(deps): bump github.com/prometheus/client_golang Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.22.0 to 1.23.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.22.0...v1.23.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-version: 1.23.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump go.opentelemetry.io/otel/exporters/prometheus Bumps [go.opentelemetry.io/otel/exporters/prometheus](https://github.com/open-telemetry/opentelemetry-go) from 0.59.0 to 0.59.1. - [Release notes](https://github.com/open-telemetry/opentelemetry-go/releases) - [Changelog](https://github.com/open-telemetry/opentelemetry-go/blob/main/CHANGELOG.md) - [Commits](open-telemetry/opentelemetry-go@exporters/prometheus/v0.59.0...exporters/prometheus/v0.59.1) --- updated-dependencies: - dependency-name: go.opentelemetry.io/otel/exporters/prometheus dependency-version: 0.59.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump gofr.dev in /examples/using-add-filestore Bumps [gofr.dev](https://github.com/gofr-dev/gofr) from 1.42.4 to 1.42.5. - [Release notes](https://github.com/gofr-dev/gofr/releases) - [Commits](v1.42.4...v1.42.5) --- updated-dependencies: - dependency-name: gofr.dev dependency-version: 1.42.5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump github.com/ClickHouse/clickhouse-go/v2 Bumps [github.com/ClickHouse/clickhouse-go/v2](https://github.com/ClickHouse/clickhouse-go) from 2.39.0 to 2.40.1. - [Release notes](https://github.com/ClickHouse/clickhouse-go/releases) - [Changelog](https://github.com/ClickHouse/clickhouse-go/blob/main/CHANGELOG.md) - [Commits](ClickHouse/clickhouse-go@v2.39.0...v2.40.1) --- updated-dependencies: - dependency-name: github.com/ClickHouse/clickhouse-go/v2 dependency-version: 2.40.1 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump crate-ci/typos in the actions group Bumps the actions group with 1 update: [crate-ci/typos](https://github.com/crate-ci/typos). Updates `crate-ci/typos` from 1.34.0 to 1.35.1 - [Release notes](https://github.com/crate-ci/typos/releases) - [Changelog](https://github.com/crate-ci/typos/blob/master/CHANGELOG.md) - [Commits](crate-ci/typos@v1.34.0...v1.35.1) --- updated-dependencies: - dependency-name: crate-ci/typos dependency-version: 1.35.1 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: actions ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump github.com/prometheus/client_golang Bumps [github.com/prometheus/client_golang](https://github.com/prometheus/client_golang) from 1.22.0 to 1.23.0. - [Release notes](https://github.com/prometheus/client_golang/releases) - [Changelog](https://github.com/prometheus/client_golang/blob/main/CHANGELOG.md) - [Commits](prometheus/client_golang@v1.22.0...v1.23.0) --- updated-dependencies: - dependency-name: github.com/prometheus/client_golang dependency-version: 1.23.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump google.golang.org/api from 0.243.0 to 0.244.0 Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.243.0 to 0.244.0. - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](googleapis/google-api-go-client@v0.243.0...v0.244.0) --- updated-dependencies: - dependency-name: google.golang.org/api dependency-version: 0.244.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump modernc.org/sqlite from 1.38.1 to 1.38.2 Bumps [modernc.org/sqlite](https://gitlab.com/cznic/sqlite) from 1.38.1 to 1.38.2. - [Commits](https://gitlab.com/cznic/sqlite/compare/v1.38.1...v1.38.2) --- updated-dependencies: - dependency-name: modernc.org/sqlite dependency-version: 1.38.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps): bump github.com/golang-jwt/jwt/v5 from 5.2.3 to 5.3.0 Bumps [github.com/golang-jwt/jwt/v5](https://github.com/golang-jwt/jwt) from 5.2.3 to 5.3.0. - [Release notes](https://github.com/golang-jwt/jwt/releases) - [Changelog](https://github.com/golang-jwt/jwt/blob/main/VERSION_HISTORY.md) - [Commits](golang-jwt/jwt@v5.2.3...v5.3.0) --- updated-dependencies: - dependency-name: github.com/golang-jwt/jwt/v5 dependency-version: 5.3.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * Merge pull request #2135 from gofr-dev/fix-docs * update release version to v1.43.0 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: HootingConjuror <[email protected]> Co-authored-by: HeerakKashyap <[email protected]> Co-authored-by: coolwednesday <[email protected]> Co-authored-by: Divya Darshana <[email protected]> Co-authored-by: ccoVeille <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

feat: improve OnStart hook with DI context, update docs, and ensure c…

8202ed1

…ode quality

ccoVeille reviewed Jul 19, 2025

View reviewed changes

go.work.sum Outdated Show resolved Hide resolved

pkg/gofr/run.go Outdated Show resolved Hide resolved

pkg/gofr/run.go Outdated Show resolved Hide resolved

pkg/gofr/run.go Outdated Show resolved Hide resolved

ccoVeille reviewed Jul 19, 2025

View reviewed changes

pkg/gofr/run.go Outdated Show resolved Hide resolved

Umang01-hash requested changes Jul 21, 2025

View reviewed changes

pkg/gofr/run.go Outdated Show resolved Hide resolved

pkg/gofr/run.go Outdated Show resolved Hide resolved

pkg/gofr/run.go Outdated Show resolved Hide resolved

examples/http-server/main.go Outdated Show resolved Hide resolved

refactor: improve OnStart hook context, move logic to method, and tes…

0cb726b

…t DI access

HeerakKashyap force-pushed the fix/onstart-di-context branch from 57c4743 to 8526959 Compare July 21, 2025 14:38

Merge branch 'development' into fix/onstart-di-context

2cbe7e1

HeerakKashyap changed the title ~~feat: add OnStart hook for synchronous startup jobs (closes #1833)~~ feat: add OnStart hook for synchronous startup jobs Jul 22, 2025

Umang01-hash and others added 2 commits July 22, 2025 14:15

Merge branch 'development' into fix/onstart-di-context

79f0fa5

Merge branch 'development' into fix/onstart-di-context

2cf9cbf

ccoVeille reviewed Jul 22, 2025

View reviewed changes

pkg/gofr/run.go Outdated Show resolved Hide resolved

HeerakKashyap added 2 commits July 22, 2025 23:54

fix: improve startup error handling for OnStart hooks (graceful shutd…

9fd31d4

…own on context cancel)

Merge branch 'fix/onstart-di-context' of https://github.com/HeerakKas…

7c38332

…hyap/gofr into fix/onstart-di-context

ccoVeille reviewed Jul 22, 2025

View reviewed changes

pkg/gofr/run.go Outdated Show resolved Hide resolved

ccoVeille approved these changes Jul 23, 2025

View reviewed changes

Umang01-hash requested changes Jul 23, 2025

View reviewed changes

pkg/gofr/gofr.go Outdated Show resolved Hide resolved

pkg/gofr/gofr.go Outdated Show resolved Hide resolved

HeerakKashyap added 3 commits July 23, 2025 22:56

fix: address linter errors in OnStart tests

27ca38f

- Fix dynamic error definition - Fix unused parameters with underscore - Use t.Context() instead of context.Background() - Use assert.NoError instead of assert.Nil

fix: remove os.Exit call to resolve deep-exit linter error

463b194

fix: resolve remaining linter errors

9e8bcdf

- Fix cuddled return statement in newContextForHooks - Fix cuddled assignment in OnStart test - Remove os.Exit call to resolve deep-exit error

HeerakKashyap force-pushed the fix/onstart-di-context branch from f4882d6 to 9e8bcdf Compare July 23, 2025 17:52

refactor: remove newContextForHooks and reuse existing newContext fun…

55d94eb

…ction

Merge branch 'development' into fix/onstart-di-context

8197a5c

HeerakKashyap and others added 5 commits July 31, 2025 22:38

fix: implement proper context usage in runOnStartHooks and fix exampl…

f6d01dc

…e API usage

Merge branch 'fix/onstart-di-context' of https://github.com/HeerakKas…

177ba8e

…hyap/gofr into fix/onstart-di-context

Update go.work.sum

03212c8

fix: correct spelling of 'canceled' in comment

b04cfd9

Merge branch 'fix/onstart-di-context' of https://github.com/HeerakKas…

ac7d03c

…hyap/gofr into fix/onstart-di-context

HeerakKashyap requested review from coolwednesday and aryanmehrotra August 1, 2025 09:17

HeerakKashyap and others added 3 commits August 3, 2025 22:01

Merge branch 'development' into fix/onstart-di-context

370aaaa

minor documentation fix

7b633ea

revert go.sum changes

8681c95

coolwednesday previously approved these changes Aug 4, 2025

View reviewed changes

Umang01-hash previously approved these changes Aug 4, 2025

View reviewed changes

ccoVeille reviewed Aug 4, 2025

View reviewed changes

pkg/gofr/gofr_test.go Outdated Show resolved Hide resolved

coolwednesday and others added 2 commits August 4, 2025 15:40

Merge branch 'development' into fix/onstart-di-context

d343f27

Update pkg/gofr/gofr_test.go

1db6c03

Co-authored-by: ccoVeille <[email protected]>

HeerakKashyap dismissed stale reviews from coolwednesday and Umang01-hash via 1db6c03 August 4, 2025 10:36

coolwednesday previously approved these changes Aug 4, 2025

View reviewed changes

revert go.work.sum changes

dd43427

coolwednesday dismissed their stale review via dd43427 August 4, 2025 11:31

coolwednesday approved these changes Aug 4, 2025

View reviewed changes

aryanmehrotra approved these changes Aug 4, 2025

View reviewed changes

aryanmehrotra merged commit 58fdefb into gofr-dev:development Aug 4, 2025
14 checks passed

feat: add OnStart hook for synchronous startup jobs #2079

feat: add OnStart hook for synchronous startup jobs #2079

Conversation

HeerakKashyap commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Umang01-hash left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HeerakKashyap commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Umang01-hash commented Jul 21, 2025

Uh oh!

HeerakKashyap commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

HeerakKashyap commented Jul 22, 2025

Uh oh!

Uh oh!

ccoVeille commented Jul 22, 2025

Uh oh!

HeerakKashyap commented Jul 23, 2025

Uh oh!

HeerakKashyap commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

Umang01-hash commented Jul 23, 2025

Uh oh!

HeerakKashyap commented Jul 30, 2025

Uh oh!

coolwednesday commented Jul 31, 2025

Uh oh!

HeerakKashyap commented Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coolwednesday commented Jul 31, 2025

Uh oh!

coolwednesday commented Jul 31, 2025

Uh oh!

coolwednesday left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HeerakKashyap commented Jul 19, 2025 •

edited

Loading

Umang01-hash left a comment •

edited

Loading

HeerakKashyap commented Jul 21, 2025 •

edited

Loading

HeerakKashyap commented Jul 21, 2025 •

edited

Loading

HeerakKashyap commented Jul 31, 2025 •

edited

Loading